/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.catalina.ant.jmx;

import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.ProjectComponent;
import org.apache.tools.ant.taskdefs.condition.Condition;

import javax.management.MBeanServerConnection;
import javax.management.ObjectName;
import java.io.IOException;
import java.net.MalformedURLException;

/**
 * Definition
 * <pre>
 *   &lt;path id="catalina_ant">
 *       &lt;fileset dir="${catalina.home}/server/lib">
 *           &lt;include name="catalina-ant.jar"/>
 *       &lt;/fileset>
 *   &lt;/path>
 *
 *   &lt;typedef
 *       name="jmxEquals"
 *       classname="org.apache.catalina.ant.jmx.JMXAccessorEqualsCondition"
 *       classpathref="catalina_ant"/>
 * </pre>
 * <p>
 * usage: Wait for start backup node
 * <pre>
 *     &lt;target name="wait"&gt;
 *        &lt;waitfor maxwait="${maxwait}" maxwaitunit="second" timeoutproperty="server.timeout" &gt;
 *           &lt;and&gt;
 *               &lt;socket server="${server.name}" port="${server.port}"/&gt;
 *               &lt;http url="${url}"/&gt;
 *               &lt;jmxEquals
 *                   host="localhost" port="9014" username="controlRole" password="tomcat"
 *                   name="Catalina:type=IDataSender,host=localhost,senderAddress=192.168.111.1,senderPort=9025"
 *                   attribute="connected" value="true"
 *               /&gt;
 *           &lt;/and&gt;
 *       &lt;/waitfor&gt;
 *       &lt;fail if="server.timeout" message="Server ${url} don't answer inside ${maxwait} sec" /&gt;
 *       &lt;echo message="Server ${url} alive" /&gt;
 *   &lt;/target&gt;
 *
 * </pre>
 *
 * @author Peter Rossbach
 * @since 5.5.10
 */
public class JMXAccessorEqualsCondition extends ProjectComponent implements Condition {

	// ----------------------------------------------------- Instance Variables

	/**
	 * Descriptive information describing this implementation.
	 */
	private static final String info = "org.apache.catalina.ant.JMXAccessorEqualsCondition/1.1";
	private String url = null;
	private String host = "localhost";
	private String port = "8050";
	private String password = null;
	private String username = null;
	private String name = null;
	private String attribute;
	private String value;
	// ----------------------------------------------------- Instance Info
	private String ref = "jmx.server";

	/**
	 * Return descriptive information about this implementation and the
	 * corresponding version number, in the format
	 * <code>&lt;description&gt;/&lt;version&gt;</code>.
	 */
	public String getInfo() {

		return (info);

	}
	// ----------------------------------------------------- Properties

	/**
	 * @return Returns the attribute.
	 */
	public String getAttribute() {
		return attribute;
	}

	/**
	 * @param attribute The attribute to set.
	 */
	public void setAttribute(String attribute) {
		this.attribute = attribute;
	}

	/**
	 * @return Returns the host.
	 */
	public String getHost() {
		return host;
	}

	/**
	 * @param host The host to set.
	 */
	public void setHost(String host) {
		this.host = host;
	}

	/**
	 * @return Returns the name.
	 */
	public String getName() {
		return name;
	}

	/**
	 * @param objectName The name to set.
	 */
	public void setName(String objectName) {
		this.name = objectName;
	}

	/**
	 * @return Returns the password.
	 */
	public String getPassword() {
		return password;
	}

	/**
	 * @param password The password to set.
	 */
	public void setPassword(String password) {
		this.password = password;
	}

	/**
	 * @return Returns the port.
	 */
	public String getPort() {
		return port;
	}

	/**
	 * @param port The port to set.
	 */
	public void setPort(String port) {
		this.port = port;
	}

	/**
	 * @return Returns the url.
	 */
	public String getUrl() {
		return url;
	}

	/**
	 * @param url The url to set.
	 */
	public void setUrl(String url) {
		this.url = url;
	}

	/**
	 * @return Returns the username.
	 */
	public String getUsername() {
		return username;
	}

	/**
	 * @param username The username to set.
	 */
	public void setUsername(String username) {
		this.username = username;
	}

	/**
	 * @return Returns the value.
	 */
	public String getValue() {
		return value;
	}

	// The setter for the "value" attribute
	public void setValue(String value) {
		this.value = value;
	}

	/**
	 * @return Returns the ref.
	 */
	public String getRef() {
		return ref;
	}

	/**
	 * @param refId The ref to set.
	 */
	public void setRef(String refId) {
		this.ref = refId;
	}

	protected MBeanServerConnection getJMXConnection()
			throws MalformedURLException, IOException {
		return JMXAccessorTask.accessJMXConnection(
				getProject(),
				getUrl(), getHost(),
				getPort(), getUsername(), getPassword(), ref);
	}

	/**
	 * @return The value
	 */
	protected String accessJMXValue() {
		try {
			Object result = getJMXConnection().getAttribute(
					new ObjectName(name), attribute);
			if (result != null)
				return result.toString();
		} catch (Exception e) {
			// ignore access or connection open errors
		}
		return null;
	}

	// This method evaluates the condition
	@Override
	public boolean eval() {
		if (value == null) {
			throw new BuildException("value attribute is not set");
		}
		if ((name == null || attribute == null)) {
			throw new BuildException(
					"Must specify a 'attribute', name for equals condition");
		}
		//FIXME check url or host/parameter
		String jmxValue = accessJMXValue();
		if (jmxValue != null)
			return jmxValue.equals(value);
		return false;
	}
}

